<html><head>
<link href="style.css" rel="stylesheet" type="text/css"/>
<title>Thrift module: Types</title></head><body>
<h1>Thrift module: Types</h1>
<table><tr><th>Module</th><th>Services</th><th>Data types</th><th>Constants</th></tr>
<tr>
<td>Types</td><td></td>
<td><a href="Types.html#Struct_Accounting">Accounting</a><br/>
<a href="Types.html#Struct_Ad">Ad</a><br/>
<a href="Types.html#Struct_Data">Data</a><br/>
<a href="Types.html#Typedef_Guid">Guid</a><br/>
<a href="Types.html#Struct_LinkedNotebook">LinkedNotebook</a><br/>
<a href="Types.html#Struct_Note">Note</a><br/>
<a href="Types.html#Struct_NoteAttributes">NoteAttributes</a><br/>
<a href="Types.html#Enum_NoteSortOrder">NoteSortOrder</a><br/>
<a href="Types.html#Struct_Notebook">Notebook</a><br/>
<a href="Types.html#Enum_PremiumOrderStatus">PremiumOrderStatus</a><br/>
<a href="Types.html#Enum_PrivilegeLevel">PrivilegeLevel</a><br/>
<a href="Types.html#Struct_Publishing">Publishing</a><br/>
<a href="Types.html#Enum_QueryFormat">QueryFormat</a><br/>
<a href="Types.html#Struct_Resource">Resource</a><br/>
<a href="Types.html#Struct_ResourceAttributes">ResourceAttributes</a><br/>
<a href="Types.html#Struct_SavedSearch">SavedSearch</a><br/>
<a href="Types.html#Struct_SharedNotebook">SharedNotebook</a><br/>
<a href="Types.html#Struct_Tag">Tag</a><br/>
<a href="Types.html#Typedef_Timestamp">Timestamp</a><br/>
<a href="Types.html#Struct_User">User</a><br/>
<a href="Types.html#Struct_UserAttributes">UserAttributes</a><br/>
<a href="Types.html#Typedef_UserID">UserID</a><br/>
</td>
<td><code><a href="Types.html#Const_EDAM_NOTE_SOURCE_MAIL_CLIP">EDAM_NOTE_SOURCE_MAIL_CLIP</a><br/>
<a href="Types.html#Const_EDAM_NOTE_SOURCE_MAIL_SMTP_GATEWAY">EDAM_NOTE_SOURCE_MAIL_SMTP_GATEWAY</a><br/>
<a href="Types.html#Const_EDAM_NOTE_SOURCE_WEB_CLIP">EDAM_NOTE_SOURCE_WEB_CLIP</a><br/>
</code></td>
</tr></table>
<hr/><h2 id="Constants">Constants</h2>
<table><tr><th>Constant</th><th>Type</th><th>Value</th></tr>
<tr id="Const_EDAM_NOTE_SOURCE_WEB_CLIP"><td><code>EDAM_NOTE_SOURCE_WEB_CLIP</code></td><td><code><code>string</code></code></td><td><code>"web.clip"</code></td></tr><tr><td colspan="3"><blockquote>Standardized value for the 'source' NoteAttribute for notes that
were clipped from the web in some manner.
<br/></blockquote></td></tr><tr id="Const_EDAM_NOTE_SOURCE_MAIL_CLIP"><td><code>EDAM_NOTE_SOURCE_MAIL_CLIP</code></td><td><code><code>string</code></code></td><td><code>"mail.clip"</code></td></tr><tr><td colspan="3"><blockquote>Standardized value for the 'source' NoteAttribute for notes that
were clipped from an email message.
<br/></blockquote></td></tr><tr id="Const_EDAM_NOTE_SOURCE_MAIL_SMTP_GATEWAY"><td><code>EDAM_NOTE_SOURCE_MAIL_SMTP_GATEWAY</code></td><td><code><code>string</code></code></td><td><code>"mail.smtp"</code></td></tr><tr><td colspan="3"><blockquote>Standardized value for the 'source' NoteAttribute for notes that
were created via email sent to Evernote's email interface.
<br/></blockquote></td></tr></table><hr/><h2 id="Enumerations">Enumerations</h2>
<div class="definition"><h3 id="Enum_PrivilegeLevel">Enumeration: PrivilegeLevel</h3>
This enumeration defines the possible permission levels for a user.
Free accounts will have a level of NORMAL and paid Premium accounts
will have a level of PREMIUM.
<br/><br/><table>
<tr><td><code>NORMAL</code></td><td><code>1</code></td></tr>
<tr><td><code>PREMIUM</code></td><td><code>3</code></td></tr>
<tr><td><code>MANAGER</code></td><td><code>7</code></td></tr>
<tr><td><code>ADMIN</code></td><td><code>9</code></td></tr>
</table></div>
<div class="definition"><h3 id="Enum_QueryFormat">Enumeration: QueryFormat</h3>
Every search query is specified as a sequence of characters.
Currently, only the USER query format is supported.
<br/><br/><table>
<tr><td><code>USER</code></td><td><code>1</code></td></tr>
<tr><td><code>SEXP</code></td><td><code>2</code></td></tr>
</table></div>
<div class="definition"><h3 id="Enum_NoteSortOrder">Enumeration: NoteSortOrder</h3>
This enumeration defines the possible sort ordering for notes when
they are returned from a search result.
<br/><br/><table>
<tr><td><code>CREATED</code></td><td><code>1</code></td></tr>
<tr><td><code>UPDATED</code></td><td><code>2</code></td></tr>
<tr><td><code>RELEVANCE</code></td><td><code>3</code></td></tr>
<tr><td><code>UPDATE_SEQUENCE_NUMBER</code></td><td><code>4</code></td></tr>
</table></div>
<div class="definition"><h3 id="Enum_PremiumOrderStatus">Enumeration: PremiumOrderStatus</h3>
This enumeration defines the possible states of a premium account
<p/>
NONE:    the user has never attempted to become a premium subscriber
<p/>
PENDING: the user has requested a premium account but their charge has not
  been confirmed
<p/>
ACTIVE:  the user has been charged and their premium account is in good
 standing
<p/>
FAILED:  the system attempted to charge the was denied. Their premium
  privileges have been revoked. We will periodically attempt to re-validate
  their order.
<p/>
CANCELLATION_PENDING: the user has requested that no further charges be made
  but the current account is still active.
<p/>
CANCELED: the premium account was canceled either because of failure to pay
  or user cancelation. No more attempts will be made to activate the account.
<br/><br/><table>
<tr><td><code>NONE</code></td><td><code>0</code></td></tr>
<tr><td><code>PENDING</code></td><td><code>1</code></td></tr>
<tr><td><code>ACTIVE</code></td><td><code>2</code></td></tr>
<tr><td><code>FAILED</code></td><td><code>3</code></td></tr>
<tr><td><code>CANCELLATION_PENDING</code></td><td><code>4</code></td></tr>
<tr><td><code>CANCELED</code></td><td><code>5</code></td></tr>
</table></div>
<hr/><h2 id="Typedefs">Type declarations</h2>
<div class="definition"><h3 id="Typedef_UserID">Typedef: UserID</h3>
<p><strong>Base type:</strong>&nbsp;<code>i32</code></p>
Every Evernote account is assigned a unique numeric identifier which
will not change for the life of the account.  This is independent of
the (string-based) "username" which is known by the user for login
purposes.  The user should have no reason to know their UserID.
<br/></div>
<div class="definition"><h3 id="Typedef_Guid">Typedef: Guid</h3>
<p><strong>Base type:</strong>&nbsp;<code>string</code></p>
Most data elements within a user's account (e.g. notebooks, notes, tags,
resources, etc.) are internally referred to using a globally unique
identifier that is written in a standard string format.  For example:
<p/>
   "8743428c-ef91-4d05-9e7c-4a2e856e813a"
<p/>
The internal components of the GUID are not given any particular meaning:
only the entire string is relevant as a unique identifier.
<br/></div>
<div class="definition"><h3 id="Typedef_Timestamp">Typedef: Timestamp</h3>
<p><strong>Base type:</strong>&nbsp;<code>i64</code></p>
An Evernote Timestamp is the date and time of an event in UTC time.
This is expressed as a specific number of milliseconds since the
standard base "epoch" of:
<p/>
   January 1, 1970, 00:00:00 GMT
<p/>
NOTE:  the time is expressed at the resolution of milliseconds, but
the value is only precise to the level of seconds.   This means that
the last three (decimal) digits of the timestamp will be '000'.
<p/>
The Thrift IDL specification does not include a native date/time type,
so this value is used instead.
<br/></div>
<hr/><h2 id="Structs">Data structures</h2>
<div class="definition"><h3 id="Struct_Data">Struct: Data</h3>
<table><tr><th>Field</th><th>Type</th><th>Required</th><th>Default value</th></tr>
<tr><td>bodyHash</td><td><code>string</code></td><td>yes</td><td></td></tr>
<tr><td>size</td><td><code>i32</code></td><td>yes</td><td></td></tr>
<tr><td>body</td><td><code>string</code></td><td>no</td><td></td></tr>
</table><br/> In several places, EDAM exchanges blocks of bytes of data for a component
 which may be relatively large.  For example:  the contents of a clipped
 HTML note, the bytes of an embedded image, or the recognition XML for
 a large image.  This structure is used in the protocol to represent
 any of those large blocks of data when they are transmitted or when
 they are only referenced their metadata.
<p/>
<dl>
 <dt>bodyHash</dt>
   <dd>This field carries a one-way hash of the contents of the
   data body, in binary form.  The hash function is MD5<br/>
   Length:  EDAM_HASH_LEN (exactly)
   </dd>
<p/>
 <dt>size</dt>
   <dd>The length, in bytes, of the data body.
   </dd>
<p/>
 <dt>body</dt>
   <dd>This field is set to contain the binary contents of the data
   whenever the resource is being transferred.  If only metadata is
   being exchanged, this field will be empty.  For example, a client could
   notify the service about the change to an attribute for a resource
   without transmitting the binary resource contents.
   </dd>
 </dl>
<br/></div><div class="definition"><h3 id="Struct_UserAttributes">Struct: UserAttributes</h3>
<table><tr><th>Field</th><th>Type</th><th>Required</th><th>Default value</th></tr>
<tr><td>defaultLocationName</td><td><code>string</code></td><td>no</td><td></td></tr>
<tr><td>defaultLatitude</td><td><code>double</code></td><td>no</td><td></td></tr>
<tr><td>defaultLongitude</td><td><code>double</code></td><td>no</td><td></td></tr>
<tr><td>preactivation</td><td><code>bool</code></td><td>no</td><td></td></tr>
<tr><td>viewedPromotions</td><td><code>list&lt;<code>string</code>&gt;</code></td><td>no</td><td></td></tr>
<tr><td>incomingEmailAddress</td><td><code>string</code></td><td>no</td><td></td></tr>
<tr><td>recentMailedAddresses</td><td><code>list&lt;<code>string</code>&gt;</code></td><td>no</td><td></td></tr>
<tr><td>comments</td><td><code>string</code></td><td>no</td><td></td></tr>
<tr><td>dateAgreedToTermsOfService</td><td><code><a href="Types.html#Typedef_Timestamp">Timestamp</a></code></td><td>no</td><td></td></tr>
<tr><td>maxReferrals</td><td><code>i32</code></td><td>no</td><td></td></tr>
<tr><td>referralCount</td><td><code>i32</code></td><td>no</td><td></td></tr>
<tr><td>refererCode</td><td><code>string</code></td><td>no</td><td></td></tr>
<tr><td>sentEmailDate</td><td><code><a href="Types.html#Typedef_Timestamp">Timestamp</a></code></td><td>no</td><td></td></tr>
<tr><td>sentEmailCount</td><td><code>i32</code></td><td>no</td><td></td></tr>
<tr><td>dailyEmailLimit</td><td><code>i32</code></td><td>no</td><td></td></tr>
<tr><td>emailOptOutDate</td><td><code><a href="Types.html#Typedef_Timestamp">Timestamp</a></code></td><td>no</td><td></td></tr>
<tr><td>partnerEmailOptInDate</td><td><code><a href="Types.html#Typedef_Timestamp">Timestamp</a></code></td><td>no</td><td></td></tr>
<tr><td>preferredLanguage</td><td><code>string</code></td><td>no</td><td></td></tr>
<tr><td>preferredCountry</td><td><code>string</code></td><td>no</td><td></td></tr>
<tr><td>clipFullPage</td><td><code>bool</code></td><td>no</td><td></td></tr>
<tr><td>twitterUserName</td><td><code>string</code></td><td>no</td><td></td></tr>
<tr><td>twitterId</td><td><code>string</code></td><td>no</td><td></td></tr>
</table><br/> A structure holding the optional attributes that can be stored
 on a User.  These are generally less critical than the core User fields.
<p/>
<dl>
 <dt>defaultLocationName</dt>
   <dd>the location string that should be associated
   with the user in order to determine where notes are taken if not otherwise
   specified.<br/>
   Length:  EDAM_ATTRIBUTE_LEN_MIN - EDAM_ATTRIBUTE_LEN_MAX
   </dd>
<p/>
 <dt>defaultLatitude</dt>
   <dd>if set, this is the latitude that should be
   assigned to any notes that have no other latitude information.
   </dd>
<p/>
 <dt>defaultLongitude</dt>
   <dd>if set, this is the longitude that should be
   assigned to any notes that have no other longitude information.
   </dd>
<p/>
 <dt>preactivation</dt>
   <dd>if set, the user account is not yet confirmed for
   login.  I.e. the account has been created, but we are still waiting for
   the user to complete the activation step.
   </dd>
<p/>
 <dt>viewedPromotions</dt>
   <dd>a list of promotions the user has seen.
    This list may occasionally be modified by the system when promotions are
    no longer available.<br/>
    Length:  EDAM_ATTRIBUTE_LEN_MIN - EDAM_ATTRIBUTE_LEN_MAX
   </dd>
<p/>
 <dt>incomingEmailAddress</dt>
   <dd>if set, this is the email address that the
    user may send email to in order to add an email note directly into the
    account via the SMTP email gateway.  This is the part of the email
    address before the '@' symbol ... our domain is not included.
    If this is not set, the user may not add notes via the gateway.<br/>
    Length:  EDAM_ATTRIBUTE_LEN_MIN - EDAM_ATTRIBUTE_LEN_MAX
   </dd>
<p/>
 <dt>recentMailedAddresses</dt>
   <dd>if set, this will contain a list of email
    addresses that have recently been used as recipients
    of outbound emails by the user.  This can be used to pre-populate a
    list of possible destinations when a user wishes to send a note via
    email.<br/>
    Length:  EDAM_ATTRIBUTE_LEN_MIN - EDAM_ATTRIBUTE_LEN_MAX each<br/>
    Max:  EDAM_USER_RECENT_MAILED_ADDRESSES_MAX entries
   </dd>
<p/>
 <dt>comments</dt>
   <dd>Free-form text field that may hold general support
    information, etc.<br/>
    Length:  EDAM_ATTRIBUTE_LEN_MIN - EDAM_ATTRIBUTE_LEN_MAX
   </dd>
<p/>
 <dt>dateAgreedToTermsOfService</dt>
   <dd>The date/time when the user agreed to
    the terms of service.  This can be used as the effective "start date"
    for the account.
   </dd>
<p/>
 <dt>maxReferrals</dt>
   <dd>The number of referrals that the user is permitted
    to make.
   </dd>
<p/>
 <dt>referralCount</dt>
   <dd>The number of referrals sent from this account.
   </dd>
<p/>
 <dt>refererCode</dt>
   <dd>A code indicating where the user was sent from. AKA
    promotion code
   </dd>
    
 <dt>sentEmailDate</dt>
   <dd>The most recent date when the user sent outbound
    emails from the service.  Used with sentEmailCount to limit the number
    of emails that can be sent per day.
   </dd>
    
 <dt>sentEmailCount</dt>
   <dd>The number of emails that were sent from the user
    via the service on sentEmailDate.  Used to enforce a limit on the number
    of emails per user per day to prevent spamming.
   </dd>
<p/>
 <dt>dailyEmailLimit</dt>
   <dd>If set, this is the maximum number of emails that
    may be sent in a given day from this account.  If unset, the server will
    use the configured default limit.
   </dd>
<p/>
 <dt>emailOptOutDate</dt>
   <dd>If set, this is the date when the user asked
    to be excluded from offers and promotions sent by Evernote.  If not set,
    then the user currently agrees to receive these messages.
   </dd>
<p/>
 <dt>partnerEmailOptInDate</dt>
   <dd>If set, this is the date when the user asked
    to be included in offers and promotions sent by Evernote's partners.
    If not sent, then the user currently does not agree to receive these
    emails.
   </dd>
<p/>
 <dt>preferredLanguage</dt>
   <dd>a 2 character language codes based on:
       http://ftp.ics.uci.edu/pub/ietf/http/related/iso639.txt used for
      localization purposes.
   </dd>
<p/>
 <dt>preferredCountry</dt>
   <dd>Preferred country code based on ISO 3166-1-alpha-2 indicating the
   users preferred country</dd>
<p/>
 <dt>clipFullPage</dt>
   <dd>Boolean flag set to true if the user wants to clip full pages by
   default when they use the web clipper without a selection.</dd>
<p/>
 <dt>twitterUserName</dt>
   <dd>The username of the account of someone who has chosen to enable
   Twittering into Evernote.  This value is subject to change, since users
   may change their Twitter user nae.</dd>
<p/>
 <dt>twitterId</dt>
   <dd>The unique identifier of the user's Twitter account if that user
   has chosen to enable Twittering into Evernote.</dd>
    
 </dl>
<br/></div><div class="definition"><h3 id="Struct_Accounting">Struct: Accounting</h3>
<table><tr><th>Field</th><th>Type</th><th>Required</th><th>Default value</th></tr>
<tr><td>uploadLimit</td><td><code>i64</code></td><td>yes</td><td></td></tr>
<tr><td>uploadLimitEnd</td><td><code><a href="Types.html#Typedef_Timestamp">Timestamp</a></code></td><td>yes</td><td></td></tr>
<tr><td>uploadLimitNextMonth</td><td><code>i64</code></td><td>yes</td><td></td></tr>
<tr><td>premiumServiceStatus</td><td><code><a href="Types.html#Enum_PremiumOrderStatus">PremiumOrderStatus</a></code></td><td>yes</td><td></td></tr>
<tr><td>premiumOrderNumber</td><td><code>string</code></td><td>no</td><td></td></tr>
<tr><td>premiumCommerceService</td><td><code>string</code></td><td>no</td><td></td></tr>
<tr><td>premiumServiceStart</td><td><code><a href="Types.html#Typedef_Timestamp">Timestamp</a></code></td><td>no</td><td></td></tr>
<tr><td>premiumServiceSKU</td><td><code>string</code></td><td>no</td><td></td></tr>
<tr><td>lastSuccessfulCharge</td><td><code><a href="Types.html#Typedef_Timestamp">Timestamp</a></code></td><td>no</td><td></td></tr>
<tr><td>lastFailedCharge</td><td><code><a href="Types.html#Typedef_Timestamp">Timestamp</a></code></td><td>no</td><td></td></tr>
<tr><td>lastFailedChargeReason</td><td><code>string</code></td><td>no</td><td></td></tr>
<tr><td>nextPaymentDue</td><td><code><a href="Types.html#Typedef_Timestamp">Timestamp</a></code></td><td>no</td><td></td></tr>
<tr><td>premiumLockUntil</td><td><code><a href="Types.html#Typedef_Timestamp">Timestamp</a></code></td><td>no</td><td></td></tr>
<tr><td>updated</td><td><code><a href="Types.html#Typedef_Timestamp">Timestamp</a></code></td><td>no</td><td></td></tr>
<tr><td>premiumSubscriptionNumber</td><td><code>string</code></td><td>no</td><td></td></tr>
<tr><td>lastRequestedCharge</td><td><code><a href="Types.html#Typedef_Timestamp">Timestamp</a></code></td><td>no</td><td></td></tr>
</table><br/> This represents the bookkeeping information for the user's subscription.
 
<dl>
 <dt>uploadLimit</dt>
   <dd>The number of bytes that can be uploaded to the account
   in the current month.  For new notes that are created, this is the length
   of the note content (in Unicode characters) plus the size of each resource
   (in bytes).  For edited notes, this is the the difference between the old
   length and the new length (if this is greater than 0) plus the size of
   each new resource.
   </dd>
 <dt>uploadLimitEnd</dt>
   <dd>The date and time when the current upload limit
   expires.  At this time, the monthly upload count reverts to 0 and a new
   limit is imposed.  This date and time is exclusive, so this is effectively
   the start of the new month.
   </dd>
 <dt>uploadLimitNextMonth</dt>
   <dd> When uploadLimitEnd is research the service
   will change uploadLimit to uploadLimitNextMonth. If a premium account is
   canceled, this mechanism will reset the quota appropriately.
   </dd>
 <dt>premiumServiceStatus</dt>
   <dd>Indicates the phases of a premium account
   during the billing process.
   </dd>
 <dt>premiumOrderNumber</dt>
   <dd>The order number used by the commerce system to
   process recurring payments
   </dd>
 <dt>premiumServiceStart</dt>
   <dd>The start date when this premium promotion
   began (this number will get overwritten if a premium service is canceled
   and then re-activated).
   </dd>
 <dt>premiumCommerceService</dt>
   <dd>The commerce system used (paypal, Google
   checkout, etc)
   </dd>
 <dt>premiumServiceSKU</dt>
   <dd>The code associated with the purchase eg. monthly
   or annual purchase. Clients should interpret this value and localize it.
   </dd>
 <dt>lastSuccessfulCharge</dt>
   <dd>Date the last time the user was charged.
   Null if never charged.
   </dd>
 <dt>lastFailedCharge</dt>
   <dd>Date the last time a charge was attempted and
   failed.
   </dd>
 <dt>lastFailedChargeReason</dt>
   <dd>Reason provided for the charge failure
   </dd>
 <dt>nextPaymentDue</dt>
   <dd>The end of the billing cycle. This could be in the
   past if there are failed charges.
   </dd>
 <dt>premiumLockUntil</dt>
   <dd>An internal variable to manage locking operations
   on the commerce variables.
   </dd>
 <dt>updated</dt>
   <dd>The date any modification where made to this record.
   </dd>
 <dt>premiumSubscriptionNumber</dt>
   <dd>The number number identifying the
   recurring subscription used to make the recurring charges.
   </dd>
 </dl>
<br/></div><div class="definition"><h3 id="Struct_User">Struct: User</h3>
<table><tr><th>Field</th><th>Type</th><th>Required</th><th>Default value</th></tr>
<tr><td>id</td><td><code><a href="Types.html#Typedef_UserID">UserID</a></code></td><td>yes</td><td></td></tr>
<tr><td>username</td><td><code>string</code></td><td>no</td><td></td></tr>
<tr><td>email</td><td><code>string</code></td><td>no</td><td></td></tr>
<tr><td>name</td><td><code>string</code></td><td>no</td><td></td></tr>
<tr><td>timezone</td><td><code>string</code></td><td>no</td><td></td></tr>
<tr><td>privilege</td><td><code><a href="Types.html#Enum_PrivilegeLevel">PrivilegeLevel</a></code></td><td>no</td><td></td></tr>
<tr><td>created</td><td><code><a href="Types.html#Typedef_Timestamp">Timestamp</a></code></td><td>no</td><td></td></tr>
<tr><td>updated</td><td><code><a href="Types.html#Typedef_Timestamp">Timestamp</a></code></td><td>no</td><td></td></tr>
<tr><td>deleted</td><td><code><a href="Types.html#Typedef_Timestamp">Timestamp</a></code></td><td>no</td><td></td></tr>
<tr><td>active</td><td><code>bool</code></td><td>yes</td><td></td></tr>
<tr><td>shardId</td><td><code>string</code></td><td>no</td><td></td></tr>
<tr><td>attributes</td><td><code><a href="Types.html#Struct_UserAttributes">UserAttributes</a></code></td><td>no</td><td></td></tr>
<tr><td>accounting</td><td><code><a href="Types.html#Struct_Accounting">Accounting</a></code></td><td>no</td><td></td></tr>
</table><br/> This represents the information about a single user account.
<dl>
 <dt>id</dt>
   <dd>The unique numeric identifier for the account, which will not
   change for the lifetime of the account.
   </dd>
<p/>
 <dt>username</dt>
   <dd>The name that the user provides to log in to their
   account. In the future, this may be empty for some accounts if their login
   process is indirect (e.g. via social networks, etc.).
   May only contain a-z, 0-9, or '-', and may not start or end with the '-'
   <br/>
   Length:  EDAM_USER_USERNAME_LEN_MIN - EDAM_USER_USERNAME_LEN_MAX
   <br/>
   Regex:  EDAM_USER_USERNAME_REGEX
   </dd>
<p/>
 <dt>email</dt>
   <dd>The email address registered for the user.  Must comply with
   RFC 2821 and RFC 2822.<br/>
   Length:  EDAM_EMAIL_LEN_MIN - EDAM_EMAIL_LEN_MAX
   <br/>
   Regex:  EDAM_EMAIL_REGEX
   </dd>
<p/>
 <dt>name</dt>
   <dd>The printable name of the user, which may be a combination
   of given and family names.  This is used instead of separate "first"
   and "last" names due to variations in international name format/order.
   May not start or end with a whitespace character.  May contain any
   character but carriage return or newline (Unicode classes Zl and Zp).
   <br/>
   Length:  EDAM_USER_NAME_LEN_MIN - EDAM_USER_NAME_LEN_MAX
   <br/>
   Regex:  EDAM_USER_NAME_REGEX
   </dd>
<p/>
 <dt>timezone</dt>
   <dd>The zone ID for the user's default location.  If present,
   this may be used to localize the display of any timestamp for which no
   other timezone is available - for example, an note that arrives via
   a micro-browser may not contain enough information to display its
   local time, so this default timezone may be assigned to the note.
   The format must be encoded as a standard zone ID such as
   "America/Los_Angeles" or "GMT+08:00"
   <br/>
   Length:  EDAM_TIMEZONE_LEN_MIN - EDAM_TIMEZONE_LEN_MAX
   <br/>
   Regex:  EDAM_TIMEZONE_REGEX
   </dd>
<p/>
 <dt>privilege</dt>
   <dd>The level of access permitted for the user.
   </dd>
<p/>
 <dt>created</dt>
   <dd>The date and time when this user account was created in the
   service.
   </dd>
<p/>
 <dt>updated</dt>
   <dd>The date and time when this user account was last modified
   in the service.
   </dd>
<p/>
 <dt>deleted</dt>
   <dd>If the account has been deleted from the system (e.g. as
   the result of a legal request by the user), the date and time of the
   deletion will be represented here.  If not, this value will not be set.
   </dd>
<p/>
 <dt>active</dt>
   <dd>If the user account is available for login and
   synchronization, this flag will be set to true.
   </dd>
<p/>
 <dt>shardId</dt>
   <dd>The name of the virtual server that manages the state of
   this user.  This value is used internally to determine which system should
   service requests about this user's data.
   </dd>
<p/>
 <dt>attributes</dt>
   <dd>If present, this will contain a list of the attributes
   for this user account.
   </dd>
<p/>
 <dt>accounting</dt>
   <dd>Bookkeeping information for the user's subscription.
   </dd>
 </dl>
<br/></div><div class="definition"><h3 id="Struct_Tag">Struct: Tag</h3>
<table><tr><th>Field</th><th>Type</th><th>Required</th><th>Default value</th></tr>
<tr><td>guid</td><td><code><a href="Types.html#Typedef_Guid">Guid</a></code></td><td>no</td><td></td></tr>
<tr><td>name</td><td><code>string</code></td><td>yes</td><td></td></tr>
<tr><td>parentGuid</td><td><code><a href="Types.html#Typedef_Guid">Guid</a></code></td><td>no</td><td></td></tr>
<tr><td>updateSequenceNum</td><td><code>i32</code></td><td>no</td><td></td></tr>
</table><br/> A tag within a user's account is a unique name which may be organized
 a simple hierarchy.
<dl>
 <dt>guid</dt>
   <dd>The unique identifier of this tag. Will be set by the service,
   so may be omitted by the client when creating the Tag.
   <br/>
   Length:  EDAM_GUID_LEN_MIN - EDAM_GUID_LEN_MAX
   <br/>
   Regex:  EDAM_GUID_REGEX
   </dd>
<p/>
 <dt>name</dt>
   <dd>A sequence of characters representing the tag's identifier.
   Case is preserved, but is ignored for comparisons.
   This means that an account may only have one tag with a given name, via
   case-insensitive comparison, so an account may not have both "food" and
   "Food" tags.
   May not contain a comma (','), and may not begin or end with a space.
   <br/>
   Length:  EDAM_TAG_NAME_LEN_MIN - EDAM_TAG_NAME_LEN_MAX
   <br/>
   Regex:  EDAM_TAG_NAME_REGEX
   </dd>
<p/>
 <dt>parentGuid</dt>
   <dd>If this is set, then this is the GUID of the tag that
   holds this tag within the tag organizational heirarchy.  If this is
   not set, then the tag has no parent and it is a "top level" tag.
   Cycles are not allowed (e.g. a->parent->parent == a) and will be
   rejected by the service.
   <br/>
   Length:  EDAM_GUID_LEN_MIN - EDAM_GUID_LEN_MAX
   <br/>
   Regex:  EDAM_GUID_REGEX
   </dd>
<p/>
 <dt>updateSequenceNum</dt>
   <dd>A number identifying the last transaction to
   modify the state of this object.  The USN values are sequential within an
   account, and can be used to compare the order of modifications within the
   service.
   </dd>
 </dl>
<br/></div><div class="definition"><h3 id="Struct_ResourceAttributes">Struct: ResourceAttributes</h3>
<table><tr><th>Field</th><th>Type</th><th>Required</th><th>Default value</th></tr>
<tr><td>sourceURL</td><td><code>string</code></td><td>no</td><td></td></tr>
<tr><td>timestamp</td><td><code><a href="Types.html#Typedef_Timestamp">Timestamp</a></code></td><td>no</td><td></td></tr>
<tr><td>latitude</td><td><code>double</code></td><td>no</td><td></td></tr>
<tr><td>longitude</td><td><code>double</code></td><td>no</td><td></td></tr>
<tr><td>altitude</td><td><code>double</code></td><td>no</td><td></td></tr>
<tr><td>cameraMake</td><td><code>string</code></td><td>no</td><td></td></tr>
<tr><td>cameraModel</td><td><code>string</code></td><td>no</td><td></td></tr>
<tr><td>clientWillIndex</td><td><code>bool</code></td><td>no</td><td></td></tr>
<tr><td>recoType</td><td><code>string</code></td><td>no</td><td></td></tr>
<tr><td>fileName</td><td><code>string</code></td><td>no</td><td></td></tr>
<tr><td>attachment</td><td><code>bool</code></td><td>no</td><td></td></tr>
</table><br/>Structure holding the optional attributes of a Resource
<dl>
<dt>sourceURL</dt>
  <dd>the original location where the resource was hosted
  <br/>
   Length:  EDAM_ATTRIBUTE_LEN_MIN - EDAM_ATTRIBUTE_LEN_MAX
  </dd>
<p/>
<dt>timestamp</dt>
  <dd>the date and time that is associated with this resource
  (e.g. the time embedded in an image from a digital camera with a clock)
  </dd>
<p/>
<dt>latitude</dt>
  <dd>the latitude where the resource was captured
  </dd>
<p/>
<dt>longitude</dt>
  <dd>the longitude where the resource was captured
  </dd>
<p/>
<dt>altitude</dt>
  <dd>the altitude where the resource was captured
  </dd>
<p/>
<dt>cameraMake</dt>
  <dd>information about an image's camera, e.g. as embedded in
  the image's EXIF data
  <br/>
  Length:  EDAM_ATTRIBUTE_LEN_MIN - EDAM_ATTRIBUTE_LEN_MAX
  </dd>
<p/>
<dt>cameraModel</dt>
  <dd>information about an image's camera, e.g. as embedded
  in the image's EXIF data
  <br/>
  Length:  EDAM_ATTRIBUTE_LEN_MIN - EDAM_ATTRIBUTE_LEN_MAX
  </dd>
<p/>
<dt>clientWillIndex</dt>
  <dd>if true, then the original client that submitted
  the resource plans to submit the recognition index for this resource at a
  later time.
  </dd>
<p/>
<dt>recoType</dt>
  <dd>if the resource has been indexed for searching, this
  will contain the value of the 'docType' attribute from the recoIndex.
  This may contain one of the following: 'printed', 'speech', 'handwritten',
  'picture', or 'unknown'.
  </dd>
<p/>
<dt>fileName</dt>
  <dd>if the resource came from a source that provided an
  explicit file name, the original name will be stored here.  Many resources
  come from unnamed sources, so this will not always be set.
  </dd>
<p/>
<dt>attachment</dt>
  <dd>this will be true if the resource is a Premium file attachment.  This
  will be available within the search grammar so that you can identify
  notes that contain attachments.
  </dd>
</dl>
<br/></div><div class="definition"><h3 id="Struct_Resource">Struct: Resource</h3>
<table><tr><th>Field</th><th>Type</th><th>Required</th><th>Default value</th></tr>
<tr><td>guid</td><td><code><a href="Types.html#Typedef_Guid">Guid</a></code></td><td>no</td><td></td></tr>
<tr><td>noteGuid</td><td><code><a href="Types.html#Typedef_Guid">Guid</a></code></td><td>no</td><td></td></tr>
<tr><td>data</td><td><code><a href="Types.html#Struct_Data">Data</a></code></td><td>yes</td><td></td></tr>
<tr><td>mime</td><td><code>string</code></td><td>no</td><td></td></tr>
<tr><td>width</td><td><code>i16</code></td><td>no</td><td></td></tr>
<tr><td>height</td><td><code>i16</code></td><td>no</td><td></td></tr>
<tr><td>duration</td><td><code>i16</code></td><td>no</td><td></td></tr>
<tr><td>active</td><td><code>bool</code></td><td>no</td><td></td></tr>
<tr><td>recognition</td><td><code><a href="Types.html#Struct_Data">Data</a></code></td><td>no</td><td></td></tr>
<tr><td>attributes</td><td><code><a href="Types.html#Struct_ResourceAttributes">ResourceAttributes</a></code></td><td>no</td><td></td></tr>
<tr><td>updateSequenceNum</td><td><code>i32</code></td><td>no</td><td></td></tr>
</table><br/>Every media file that is embedded or attached to a note is represented
through a Resource entry.
<dl>
<dt>guid</dt>
  <dd>The unique identifier of this resource.  Will be set whenever
  a resource is retrieved from the service, but may be null when a client
  is creating a resource.
  <br/>
  Length:  EDAM_GUID_LEN_MIN - EDAM_GUID_LEN_MAX
  <br/>
  Regex:  EDAM_GUID_REGEX
  </dd>
<p/>
<dt>noteGuid</dt>
  <dd>The unique identifier of the Note that holds this
  Resource. Will be set whenever the resource is retrieved from the service,
  but may be null when a client is creating a resource.
  <br/>
  Length:  EDAM_GUID_LEN_MIN - EDAM_GUID_LEN_MAX
  <br/>
  Regex:  EDAM_GUID_REGEX
  </dd>
<p/>
<dt>data</dt>
  <dd>The contents of the resource.
  Maximum length:  The data.body is limited to 25 MB (26214400 bytes)
  </dd>
<p/>
<dt>mime</dt>
  <dd>The MIME type for the embedded resource.  E.g. "image/gif"
  <br/>
  Length:  EDAM_MIME_LEN_MIN - EDAM_MIME_LEN_MAX
  <br/>
  Regex:  EDAM_MIME_REGEX
  </dd>
<p/>
<dt>width</dt>
  <dd>If set, this contains the display width of this resource, in
  pixels.
  </dd>
<p/>
<dt>height</dt>
  <dd>If set, this contains the display height of this resource,
  in pixels.
  </dd>
<p/>
<dt>duration</dt>
  <dd>If set, this contains the duration of this time-based
  clip, in seconds.
  </dd>
<p/>
<dt>active</dt>
  <dd>DEPRECATED: ignored.
  </dd>
<p/>
<dt>recognition</dt>
  <dd>If set, this will hold the encoded data that provides
  information on search and recognition within this resource.
  </dd>
<p/>
<dt>attributes</dt>
  <dd>A list of the attributes for this resource.
  </dd>
<p/>
<dt>updateSequenceNum</dt>
  <dd>A number identifying the last transaction to
  modify the state of this object. The USN values are sequential within an
  account, and can be used to compare the order of modifications within the
  service.
  </dd>
</dl>
<br/></div><div class="definition"><h3 id="Struct_NoteAttributes">Struct: NoteAttributes</h3>
<table><tr><th>Field</th><th>Type</th><th>Required</th><th>Default value</th></tr>
<tr><td>subjectDate</td><td><code><a href="Types.html#Typedef_Timestamp">Timestamp</a></code></td><td>no</td><td></td></tr>
<tr><td>latitude</td><td><code>double</code></td><td>no</td><td></td></tr>
<tr><td>longitude</td><td><code>double</code></td><td>no</td><td></td></tr>
<tr><td>altitude</td><td><code>double</code></td><td>no</td><td></td></tr>
<tr><td>author</td><td><code>string</code></td><td>no</td><td></td></tr>
<tr><td>source</td><td><code>string</code></td><td>no</td><td></td></tr>
<tr><td>sourceURL</td><td><code>string</code></td><td>no</td><td></td></tr>
<tr><td>sourceApplication</td><td><code>string</code></td><td>no</td><td></td></tr>
</table><br/>The list of optional attributes that can be stored on a note.
<dl>
<dt>subjectDate</dt>
  <dd>time that the note refers to
  </dd>
<p/>
<dt>latitude</dt>
  <dd>the latitude where the note was taken
  </dd>
<p/>
<dt>longitude</dt>
  <dd>the longitude where the note was taken
  </dd>
<p/>
<dt>altitude</dt>
  <dd>the altitude where the note was taken
  </dd>
<p/>
<dt>author</dt>
  <dd>the author of the content of the note
  <br/>
  Length:  EDAM_ATTRIBUTE_LEN_MIN - EDAM_ATTRIBUTE_LEN_MAX
  </dd>
<p/>
<dt>source</dt>
  <dd>the method that the note was added to the account, if the
  note wasn't directly authored in an Evernote client.
  <br/>
  Length:  EDAM_ATTRIBUTE_LEN_MIN - EDAM_ATTRIBUTE_LEN_MAX
  </dd>
<p/>
<dt>sourceURL</dt>
  <dd>the original location where the resource was hosted
  <br/>
  Length:  EDAM_ATTRIBUTE_LEN_MIN - EDAM_ATTRIBUTE_LEN_MAX
  </dd>
<p/>
<dt>sourceApplication</dt>
  <dd>an identifying string for the application that
  created this note.  This string does not have a guaranteed syntax or
  structure -- it is intended for human inspection and tracking.
  <br/>
  Length:  EDAM_ATTRIBUTE_LEN_MIN - EDAM_ATTRIBUTE_LEN_MAX
  </dd>
</dl>
<br/></div><div class="definition"><h3 id="Struct_Note">Struct: Note</h3>
<table><tr><th>Field</th><th>Type</th><th>Required</th><th>Default value</th></tr>
<tr><td>guid</td><td><code><a href="Types.html#Typedef_Guid">Guid</a></code></td><td>no</td><td></td></tr>
<tr><td>title</td><td><code>string</code></td><td>yes</td><td></td></tr>
<tr><td>content</td><td><code>string</code></td><td>no</td><td></td></tr>
<tr><td>contentHash</td><td><code>string</code></td><td>no</td><td></td></tr>
<tr><td>contentLength</td><td><code>i32</code></td><td>no</td><td></td></tr>
<tr><td>created</td><td><code><a href="Types.html#Typedef_Timestamp">Timestamp</a></code></td><td>yes</td><td></td></tr>
<tr><td>updated</td><td><code><a href="Types.html#Typedef_Timestamp">Timestamp</a></code></td><td>yes</td><td></td></tr>
<tr><td>deleted</td><td><code><a href="Types.html#Typedef_Timestamp">Timestamp</a></code></td><td>no</td><td></td></tr>
<tr><td>active</td><td><code>bool</code></td><td>no</td><td></td></tr>
<tr><td>updateSequenceNum</td><td><code>i32</code></td><td>no</td><td></td></tr>
<tr><td>notebookGuid</td><td><code>string</code></td><td>no</td><td></td></tr>
<tr><td>tagGuids</td><td><code>list&lt;<code><a href="Types.html#Typedef_Guid">Guid</a></code>&gt;</code></td><td>no</td><td></td></tr>
<tr><td>resources</td><td><code>list&lt;<code><a href="Types.html#Struct_Resource">Resource</a></code>&gt;</code></td><td>no</td><td></td></tr>
<tr><td>attributes</td><td><code><a href="Types.html#Struct_NoteAttributes">NoteAttributes</a></code></td><td>no</td><td></td></tr>
</table><br/>Represents a single note in the user's account.
<p/>
<dl>
<dt>guid</dt>
  <dd>The unique identifier of this note.  Will be set by the
  server, but will be omitted by clients calling NoteStore.createNote()
  <br/>
  Length:  EDAM_GUID_LEN_MIN - EDAM_GUID_LEN_MAX
  <br/>
  Regex:  EDAM_GUID_REGEX
  </dd>
<p/>
<dt>title</dt>
  <dd>The subject of the note.  Can't begin or end with a space.
  <br/>
  Length:  EDAM_NOTE_TITLE_LEN_MIN - EDAM_NOTE_TITLE_LEN_MAX
  <br/>
  Regex:  EDAM_NOTE_TITLE_REGEX
  </dd>
<p/>
<dt>content</dt>
  <dd>The XHTML block that makes up the note.  This is
  the canonical form of the note's contents, so will include abstract
  Evernote tags for internal resource references.  A client may create
  a separate transformed version of this content for internal presentation,
  but the same canonical bytes should be used for transmission and
  comparison unless the user chooses to modify their content.
  <br/>
  Length:  EDAM_NOTE_CONTENT_LEN_MIN - EDAM_NOTE_CONTENT_LEN_MAX
  </dd>
<p/>
<dt>contentHash</dt>
  <dd>The binary MD5 checksum of the UTF-8 encoded content
  body. This will always be set by the server, but clients may choose to omit
  this when they submit a note with content.
  <br/>
  Length:  EDAM_HASH_LEN (exactly)
  </dd>
<p/>
<dt>contentLength</dt>
  <dd>The number of Unicode characters in the content of
  the note.  This will always be set by the service, but clients may choose
  to omit this value when they submit a Note.
  </dd>
<p/>
<dt>created</dt>
  <dd>The date and time when the note was created in one of the
  clients.  In most cases, this will match the user's sense of when
  the note was created, and ordering between notes will be based on
  ordering of this field.  However, this is not a "reliable" timestamp
  if a client has an incorrect clock, so it cannot provide a true absolute
  ordering between notes.  Notes created directly through the service
  (e.g. via the web GUI) will have an absolutely ordered "created" value.
  </dd>
<p/>
<dt>updated</dt>
  <dd>The date and time when the note was last modified in one of
  the clients.  In most cases, this will match the user's sense of when
  the note was modified, but this field may not be absolutely reliable
  due to the possibility of client clock errors.
  </dd>
<p/>
<dt>deleted</dt>
  <dd>If present, the note is considered "deleted", and this
  stores the date and time when the note was deleted by one of the clients.
  In most cases, this will match the user's sense of when the note was
  deleted, but this field may be unreliable due to the possibility of
  client clock errors.
  </dd>
<p/>
<dt>active</dt>
  <dd>If the note is available for normal actions and viewing,
  this flag will be set to true.
  </dd>
<p/>
<dt>updateSequenceNum</dt>
  <dd>A number identifying the last transaction to
  modify the state of this note (including changes to the note's attributes
  or resources).  The USN values are sequential within an account,
  and can be used to compare the order of modifications within the service.
  </dd>
<p/>
<dt>notebookGuid</dt>
  <dd>The unique identifier of the notebook that contains
  this note.  If no notebookGuid is provided on a call to createNote(), the
  default notebook will be used instead.
  <br/>
  Length:  EDAM_GUID_LEN_MIN - EDAM_GUID_LEN_MAX
  <br/>
  Regex:  EDAM_GUID_REGEX
  </dd>
<p/>
<dt>tags</dt>
  <dd>A list of the tags that are applied to this note.
  If the list of tags are omitted on a call to updateNote(), then
  the server will assume that no changes have been made to the resources.
  Maximum:  EDAM_NOTE_TAGS_MAX tags per note
  </dd>
<p/>
<dt>resources</dt>
  <dd>The list of resources that are embedded within this note.
  If the list of resources are omitted on a call to updateNote(), then
  the server will assume that no changes have been made to the resources.
  The binary contents of the resources must be provided when the resource
  is first sent to the service, but it will be omitted by the service when
  the Note is returned in the future.
  Maximum:  EDAM_NOTE_RESOURCES_MAX resources per note
  </dd>
<p/>
<dt>attributes</dt>
  <dd>A list of the attributes for this note.
  If the list of attributes are omitted on a call to updateNote(), then
  the server will assume that no changes have been made to the resources.
  </dd>
</dl>
<br/></div><div class="definition"><h3 id="Struct_Publishing">Struct: Publishing</h3>
<table><tr><th>Field</th><th>Type</th><th>Required</th><th>Default value</th></tr>
<tr><td>uri</td><td><code>string</code></td><td>yes</td><td></td></tr>
<tr><td>order</td><td><code><a href="Types.html#Enum_NoteSortOrder">NoteSortOrder</a></code></td><td>yes</td><td></td></tr>
<tr><td>ascending</td><td><code>bool</code></td><td>yes</td><td></td></tr>
<tr><td>publicDescription</td><td><code>string</code></td><td>no</td><td></td></tr>
</table><br/>If a Notebook has been opened to the public, the Notebook will have a
reference to one of these structures, which gives the location and optional
description of the externally-visible public Notebook.
<dl>
<dt>uri</dt>
  <dd>If this field is present, then the notebook is published for
  mass consumption on the Internet under the provided URI, which is
  relative to a defined base publishing URI defined by the service.
  This field can only be modified via the web service GUI ... publishing
  cannot be modified via an offline client.
  <br/>
  Length:  EDAM_PUBLISHING_URI_LEN_MIN - EDAM_PUBLISHING_URI_LEN_MAX
  <br/>
  Regex:  EDAM_PUBLISHING_URI_REGEX
  </dd>
<p/>
<dt>order</dt>
  <dd>When the notes are publicly displayed, they will be sorted
  based on the requested criteria.
  </dd>
<p/>
<dt>ascending</dt>
  <dd>If this is set to true, then the public notes will be
  displayed in ascending order (e.g. from oldest to newest).  Otherwise,
  the notes will be displayed in descending order (e.g. newest to oldest).
  </dd>
<p/>
<dt>publicDescription</dt>
  <dd>This field may be used to provide a short
  description of the notebook, which may be displayed when (e.g.) the
  notebook is shown in a public view.  Can't begin or end with a space.
  <br/>
  Length:  EDAM_PUBLISHING_DESCRIPTION_LEN_MIN -
           EDAM_PUBLISHING_DESCRIPTION_LEN_MAX
  <br/>
  Regex:  EDAM_PUBLISHING_DESCRIPTION_REGEX
  </dd>
</dl>
<br/></div><div class="definition"><h3 id="Struct_Notebook">Struct: Notebook</h3>
<table><tr><th>Field</th><th>Type</th><th>Required</th><th>Default value</th></tr>
<tr><td>guid</td><td><code><a href="Types.html#Typedef_Guid">Guid</a></code></td><td>no</td><td></td></tr>
<tr><td>name</td><td><code>string</code></td><td>yes</td><td></td></tr>
<tr><td>updateSequenceNum</td><td><code>i32</code></td><td>no</td><td></td></tr>
<tr><td>defaultNotebook</td><td><code>bool</code></td><td>no</td><td></td></tr>
<tr><td>serviceCreated</td><td><code><a href="Types.html#Typedef_Timestamp">Timestamp</a></code></td><td>no</td><td></td></tr>
<tr><td>serviceUpdated</td><td><code><a href="Types.html#Typedef_Timestamp">Timestamp</a></code></td><td>no</td><td></td></tr>
<tr><td>publishing</td><td><code><a href="Types.html#Struct_Publishing">Publishing</a></code></td><td>no</td><td></td></tr>
<tr><td>published</td><td><code>bool</code></td><td>no</td><td></td></tr>
</table><br/>A unique container for a set of notes.
<dl>
<dt>guid</dt>
  <dd>The unique identifier of this notebook.
  <br/>
  Length:  EDAM_GUID_LEN_MIN - EDAM_GUID_LEN_MAX
  <br/>
  Regex:  EDAM_GUID_REGEX
  </dd>
<p/>
<dt>name</dt>
  <dd>A sequence of characters representing the name of the
  notebook.  May be changed by clients, but the account may not contain two
  notebooks with names that are equal via a case-insensitive comparison.
  Can't begin or end with a space.
  <br/>
  Length:  EDAM_NOTEBOOK_NAME_LEN_MIN - EDAM_NOTEBOOK_NAME_LEN_MAX
  <br/>
  Regex:  EDAM_NOTEBOOK_NAME_REGEX
  </dd>
<p/>
<dt>updateSequenceNum</dt>
  <dd>A number identifying the last transaction to
  modify the state of this object.  The USN values are sequential within an
  account, and can be used to compare the order of modifications within the
  service.
  </dd>
<p/>
<dt>defaultNotebook</dt>
  <dd>If true, this notebook should be used for new notes
  whenever the user has not (or cannot) specify a desired target notebook.
  For example, if a note is submitted via SMTP email.
  The service will maintain at most one defaultNotebook per account.
  If a second notebook is created or updated with defaultNotebook set to
  true, the service will automatically update the prior notebook's
  defaultNotebook field to false.  If the default notebook is deleted
  (i.e. "active" set to false), the "defaultNotebook" field will be
  set to false by the service.  If the account has no default notebook
  set, the service will use the most recent notebook as the default.
  </dd>
<p/>
<dt>serviceCreated</dt>
  <dd>The time when this notebook was created on the
  service. This will be set on the service during creation, and the service
  will provide this value when it returns a Notebook to a client.
  The service will ignore this value if it is sent by clients.
  </dd>
<p/>
<dt>serviceUpdated</dt>
  <dd>The time when this notebook was last modified on the
  service.  This will be set on the service during creation, and the service
  will provide this value when it returns a Notebook to a client.
  The service will ignore this value if it is sent by clients.
  </dd>
<p/>
<dt>publishing</dt>
  <dd>If the Notebook has been opened for public access (i.e.
  if 'published' is set to true), then this will point to the set of
  publishing information for the Notebook (URI, description, etc.).  A
  Notebook cannot be published without providing this information, but it
  will persist for later use if publishing is ever disabled on the Notebook.
  Clients that do not wish to change the publishing behavior of a Notebook
  should not set this value when calling NoteStore.updateNotebook().
  </dd>
<p/>
<dt>published</dt>
  <dd>If this is set to true, then the Notebook will be
  accessible to the public via the 'publishing' specification, which must
  also be set.  If this is set to false, the Notebook will not be available
  to the public.
  Clients that do not wish to change the publishing behavior of a Notebook
  should not set this value when calling NoteStore.updateNotebook().
  </dd>
</dl>
<br/></div><div class="definition"><h3 id="Struct_SavedSearch">Struct: SavedSearch</h3>
<table><tr><th>Field</th><th>Type</th><th>Required</th><th>Default value</th></tr>
<tr><td>guid</td><td><code><a href="Types.html#Typedef_Guid">Guid</a></code></td><td>no</td><td></td></tr>
<tr><td>name</td><td><code>string</code></td><td>yes</td><td></td></tr>
<tr><td>query</td><td><code>string</code></td><td>yes</td><td></td></tr>
<tr><td>format</td><td><code><a href="Types.html#Enum_QueryFormat">QueryFormat</a></code></td><td>yes</td><td></td></tr>
<tr><td>updateSequenceNum</td><td><code>i32</code></td><td>no</td><td></td></tr>
</table><br/>A named search associated with the account that can be quickly re-used.
<dl>
<dt>guid</dt>
  <dd>The unique identifier of this search.  Will be set by the
  service, so may be omitted by the client when creating.
  <br/>
  Length:  EDAM_GUID_LEN_MIN - EDAM_GUID_LEN_MAX
  <br/>
  Regex:  EDAM_GUID_REGEX
  </dd>
<p/>
<dt>name</dt>
  <dd>The name of the saved search to display in the GUI.  The
  account may only contain one search with a given name (case-insensitive
  compare). Can't begin or end with a space.
  <br/>
  Length:  EDAM_SAVED_SEARCH_NAME_LEN_MIN - EDAM_SAVED_SEARCH_NAME_LEN_MAX
  <br/>
  Regex:  EDAM_SAVED_SEARCH_NAME_REGEX
  </dd>
<p/>
<dt>query</dt>
  <dd>A string expressing the search to be performed.
  <br/>
  Length:  EDAM_SAVED_SEARCH_QUERY_LEN_MIN - EDAM_SAVED_SEARCH_QUERY_LEN_MAX
  </dd>
<p/>
<dt>format</dt>
  <dd>The format of the query string, to determine how to parse
  and process it.
  </dd>
<p/>
<dt>updateSequenceNum</dt>
  <dd>A number identifying the last transaction to
  modify the state of this object.  The USN values are sequential within an
  account, and can be used to compare the order of modifications within the
  service.
  </dd>
</dl>
<br/></div><div class="definition"><h3 id="Struct_Ad">Struct: Ad</h3>
<table><tr><th>Field</th><th>Type</th><th>Required</th><th>Default value</th></tr>
<tr><td>id</td><td><code>i32</code></td><td>no</td><td></td></tr>
<tr><td>width</td><td><code>i16</code></td><td>yes</td><td></td></tr>
<tr><td>height</td><td><code>i16</code></td><td>yes</td><td></td></tr>
<tr><td>advertiserName</td><td><code>string</code></td><td>no</td><td></td></tr>
<tr><td>imageUrl</td><td><code>string</code></td><td>no</td><td></td></tr>
<tr><td>destinationUrl</td><td><code>string</code></td><td>no</td><td></td></tr>
<tr><td>displaySeconds</td><td><code>i16</code></td><td>no</td><td></td></tr>
<tr><td>score</td><td><code>double</code></td><td>no</td><td></td></tr>
<tr><td>image</td><td><code>string</code></td><td>no</td><td></td></tr>
<tr><td>imageMime</td><td><code>string</code></td><td>no</td><td></td></tr>
<tr><td>html</td><td><code>string</code></td><td>no</td><td></td></tr>
<tr><td>displayFrequency</td><td><code>double</code></td><td>no</td><td></td></tr>
</table><br/>An advertisement that may be displayed within an Evernote client.
Advertisements are either a snippet of HTML or else they
are an image (of type: JPEG, GIF, PNG) with an associated destination URL.
<p/>
<dl>
  <dt>id</dt>
  <dd>The unique identifier of this advertisement within Evernote's ad
  inventory.
  </dd>
<p/>
  <dt>width</dt>
  <dd>This ad should be displayed within a rectangle that is this wide,
  in pixels.
  </dd>
<p/>
  <dt>height</dt>
  <dd>This ad should be displayed within a rectangle that is this high,
  in pixels.
  </dd>
<p/>
  <dt>advertiserName</dt>
  <dd>A string containing a readable version of the name of this advertiser.
  </dd>
<p/>
  <dt>imageUrl</dt>
  <dd>The location of the image to display for this ad.</dd>
<p/>
  <dt>destinationUrl</dt>
  <dd>When a user clicks on the ad, this is the destination they should be
  sent to in a browser.</dd>
<p/>
  <dt>displaySeconds</dt>
  <dd>The number of seconds that the ad should be displayed before it is
  replaced with a different ad.</dd>
<p/>
  <dt>score</dt>
  <dd>A numeric indicator of the relative value of this ad, which can be
  compared against other ads from the same day.
  </dd>
<p/>
  <dt>image</dt>
  <dd>If present, this is the raw image bits of the image file to display
  for the ad.  If not present, the imageUrl should be retrieved directly.
  </dd>
<p/>
  <dt>imageMime</dt>
  <dd>The MIME type of the 'image' bytes, if those are set.</dd>
<p/>
  <dt>html</dt>
  <dd>The exact HTML to display for this ad, to support rich or external
  advertisements.</dd>
<p/>
  <dt>displayFrequency</dt>
  <dd>If this value is set, this is the relatively frequency that this
  ad should be displayed in the daily set of ads, relative to a base
  frequency of 1.0.  I.e. an ad with a frequency of 3.0 should be displayed
  three times more frequently than an ad with a frequency of 1.0.</dd>
</dl>
<br/></div><div class="definition"><h3 id="Struct_SharedNotebook">Struct: SharedNotebook</h3>
<table><tr><th>Field</th><th>Type</th><th>Required</th><th>Default value</th></tr>
<tr><td>id</td><td><code>i64</code></td><td>yes</td><td></td></tr>
<tr><td>userId</td><td><code>i32</code></td><td>yes</td><td></td></tr>
<tr><td>notebookGuid</td><td><code>string</code></td><td>yes</td><td></td></tr>
<tr><td>email</td><td><code>string</code></td><td>yes</td><td></td></tr>
<tr><td>notebookModifiable</td><td><code>bool</code></td><td>yes</td><td></td></tr>
<tr><td>requireLogin</td><td><code>bool</code></td><td>yes</td><td></td></tr>
<tr><td>serviceCreated</td><td><code><a href="Types.html#Typedef_Timestamp">Timestamp</a></code></td><td>no</td><td></td></tr>
<tr><td>shareKey</td><td><code>string</code></td><td>no</td><td></td></tr>
<tr><td>username</td><td><code>string</code></td><td>no</td><td></td></tr>
</table><br/>Shared notebooks represent a relationship between a notebook and a single
share invitation recipient.
<dl>
<dt>id</dt>
<dd>the primary identifier of the share</dd>
<p/>
<dt>userId</dt>
<dd>The user id of the owner of the notebook</dd>
<p/>
<dt>notebookGuid</dt>
<dd>the GUID of the notebooks that's being shared.</dd>
<p/>
<dt>email</dt>
<dd>the email address of the recipient - used by the notebook
owner to identify who they shared with.</dd>
<p/>
<dt>notebookModifiable</dt>
<dd>a flag indicating the a share is read/write -otherwise it's read only</dd>
<p/>
<dt>requireLogin</dt><dd>indicates that a user must login to access the share</dd>
<p/>
<dt>serviceCreated</dt>
<dd>the date the owner first created the share with the specific email address</dd>
<p/>
<dt>username</dt>
<dd>the username of the user who can access this share. Once it's assigned it cannot be changed.</dd>
</dl>
<br/></div><div class="definition"><h3 id="Struct_LinkedNotebook">Struct: LinkedNotebook</h3>
<table><tr><th>Field</th><th>Type</th><th>Required</th><th>Default value</th></tr>
<tr><td>id</td><td><code>i64</code></td><td>yes</td><td></td></tr>
<tr><td>shareName</td><td><code>string</code></td><td>yes</td><td></td></tr>
<tr><td>username</td><td><code>string</code></td><td>yes</td><td></td></tr>
<tr><td>shardId</td><td><code>string</code></td><td>no</td><td></td></tr>
<tr><td>shareKey</td><td><code>string</code></td><td>no</td><td></td></tr>
<tr><td>uri</td><td><code>string</code></td><td>no</td><td></td></tr>
</table><br/>A link in an users account that refers them to a public or individual share in
another user's account.
<p/>
<dl>
<dt>id</dt>
<dd>the primary identify of a linked notebook only used for deleting.</dd>
<p/>
<dt>shareName</dt>
<dd>the display name of the shared notebook. The link owner can change this.</dd>
<p/>
<dt>username</dt>
<dd>the username of the user who owns the shared or public notebook</dd>
<p/>
<dt>shardId</dt>
<dd>the shard ID of the notebook if the notebook is not public</dt>
<p/>
<dt>shareKey</dt>
<dd>the secret key that provides access to the shared notebook</dd>
<p/>
<dt>uri</dt>
<dd>the identifier of the public notebook</dd>
<br/></div></body></html>
